Resource ExampleScenario/FHIR Server from package nhs.england.rad#current (63 ms)

Resources that use this resource

No resources found

Resources that this resource uses

No resources found

Narrative

Note: links and images are rebased to the (stated) source

Source

{
  "resourceType" : "ExampleScenario",
  "id" : "FindingImagingReportsStudiesAndImagesCentralRegistry",
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: ExampleScenario FindingImagingReportsStudiesAndImagesCentralRegistry</b></p><a name=\"FindingImagingReportsStudiesAndImagesCentralRegistry\"> </a><a name=\"hcFindingImagingReportsStudiesAndImagesCentralRegistry\"> </a><a name=\"FindingImagingReportsStudiesAndImagesCentralRegistry-en-GB\"> </a><p><b>url</b>: <a href=\"ExampleScenario-FindingImagingReportsStudiesAndImagesCentralRegistry.html\">FindingImagingReportsStudiesAndImagesCentralRegistry</a></p><p><b>version</b>: 0.0.1-current</p><p><b>name</b>: FindingImagingReportsStudiesAndImagesCentralRegistry</p><p><b>status</b>: Draft</p><p><b>date</b>: 2025-04-09 05:34:28+0000</p><p><b>publisher</b>: NHS England</p><p><b>contact</b>: <a href=\"https://www.ihe.net/ihe_domains/it_infrastructure/\">https://www.ihe.net/ihe_domains/it_infrastructure/</a>, <a href=\"mailto:iti@ihe.net\">iti@ihe.net</a>, NHS England: <a href=\"mailto:iti@ihe.net\">iti@ihe.net</a></p><p><b>jurisdiction</b>: <span title=\"Codes:{urn:iso:std:iso:3166 GB}\">United Kingdom of Great Britain and Northern Ireland</span></p><blockquote><p><b>actor</b></p><p><b>actorId</b>: user</p><p><b>type</b>: System</p><p><b>name</b>: Document Consumer</p><p><b>description</b>: </p><div><p>The <a href=\"ActorDefinition-DocumentConsumer.html\">Document Consumer</a> Actor queries for documents meeting certain criteria, and may retrieve selected documents.</p>\n</div></blockquote><blockquote><p><b>actor</b></p><p><b>actorId</b>: xds</p><p><b>type</b>: System</p><p><b>name</b>: Document Registry</p><p><b>description</b>: </p><div><p>The <a href=\"ActorDefinition-DocumentRegistry.html\">Document Registry</a> Actor maintains metadata about each registered document in a document entry. This includes a link to the Document in the Repository where it is stored. The Document Registry responds to queries from Document Consumer actors about documents meeting specific criteria.</p>\n</div></blockquote><blockquote><p><b>actor</b></p><p><b>actorId</b>: docs</p><p><b>type</b>: System</p><p><b>name</b>: Document Repository</p><p><b>description</b>: </p><div><p>The <a href=\"ActorDefinition-DocumentRepository.html\">Document Repository</a> is responsible for both the persistent storage of these documents (e.g. Imaging Report)</p>\n</div></blockquote><blockquote><p><b>actor</b></p><p><b>actorId</b>: image</p><p><b>type</b>: System</p><p><b>name</b>: Imaging Repository</p><p><b>description</b>: </p><div><p>The <a href=\"ActorDefinition-ImagingRepository.html\">Imaging Repository</a> is responsible for both the persistent storage of DICOM Images and Imaging Studies, these may also contain Imaging Reports. This is also known as a PACS.</p>\n</div></blockquote><blockquote><p><b>instance</b></p><p><b>resourceId</b>: NRLSearchDocumentEntries</p><p><b>resourceType</b>: Binary</p><p><b>name</b>: Query for Document Entries</p><p><b>description</b>: </p><div><p>See <a href=\"CapabilityStatement-FindDocumentsNRL.html\">Finding and Retrieving Document Entries (NRL)</a> for API base contract. E.g.</p>\n<pre><code>GET https://example.nhs.uk/FHIR/R4/DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|9912003888\n</code></pre>\n</div></blockquote><blockquote><p><b>instance</b></p><p><b>resourceId</b>: NRLReturnDocumentEntries</p><p><b>resourceType</b>: Bundle</p><p><b>name</b>: Return Document Entry results</p><blockquote><p><b>version</b></p><p><b>Extension Definition for ExampleScenario.instance.version.title for Version 5.0</b>: Search Results NRL</p><p><b>Extension Definition for ExampleScenario.instance.version.content for Version 5.0</b>: <a href=\"Bundle-NRLSearchResultsDocuments.html\">Bundle: type = searchset; total = 1</a></p><p><b>versionId</b>: 1</p></blockquote></blockquote><blockquote><p><b>instance</b></p><p><b>resourceId</b>: NRLSearchDiagnosticReports</p><p><b>resourceType</b>: Binary</p><p><b>name</b>: Query for DiagnosticReport</p><p><b>description</b>: </p><div><p>See <a href=\"CapabilityStatement-FindAndRetrieveImagingReports.html\">Find and Retrieve Imaging Reports</a> for API base contract. E.g.</p>\n<pre><code>GET https://example.nhs.uk/FHIR/R4/DiagnosticReport?_id=ABCD\n</code></pre>\n</div></blockquote><blockquote><p><b>instance</b></p><p><b>resourceId</b>: NRLReturnDiagnosticReports</p><p><b>resourceType</b>: Bundle</p><p><b>name</b>: Return DiagnosticReport results</p><blockquote><p><b>version</b></p><p><b>Extension Definition for ExampleScenario.instance.version.title for Version 5.0</b>: Search Diagnostic Report by _id </p><p><b>Extension Definition for ExampleScenario.instance.version.content for Version 5.0</b>: <a href=\"Bundle-NRLSearchDiagnosticReports.html\">Bundle: type = searchset; total = 1</a></p><p><b>versionId</b>: 1</p></blockquote></blockquote><blockquote><p><b>instance</b></p><p><b>resourceId</b>: NRLRetrieveImagingStudy</p><p><b>resourceType</b>: Binary</p><p><b>name</b>: Read ImagingStudy</p><p><b>description</b>: </p><div><p>See <a href=\"CapabilityStatement-RetrieveImagingStudy.html\">Retrieve Imaging Study</a> for API overview</p>\n</div></blockquote><blockquote><p><b>instance</b></p><p><b>resourceId</b>: NRLRetrieveImagingStudyResult</p><p><b>resourceType</b>: Binary</p><p><b>name</b>: Return Imaging Study</p><p><b>description</b>: </p><div><p>DICOM KOS</p>\n</div></blockquote><blockquote><p><b>instance</b></p><p><b>resourceId</b>: NRLRetrieveImage</p><p><b>resourceType</b>: Binary</p><p><b>name</b>: Read Image Instance</p><p><b>description</b>: </p><div><p>See <a href=\"CapabilityStatement-RetrieveImageInstances.html\">Retrieve Image Instances</a> for API overview</p>\n</div></blockquote><blockquote><p><b>instance</b></p><p><b>resourceId</b>: NRLRetrieveImageResult</p><p><b>resourceType</b>: Binary</p><p><b>name</b>: Return Image</p><p><b>description</b>: </p><div><p>DICOM Image Instance</p>\n</div></blockquote><blockquote><p><b>process</b></p><p><b>title</b>: Query patient image and/or report</p><blockquote><p><b>step</b></p><blockquote><p><b>operation</b></p><p><b>number</b>: 1</p><p><b>type</b>: search-type</p><p><b>name</b>: Search for Documents</p><p><b>initiator</b>: user</p><p><b>receiver</b>: xds</p><h3>Requests</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>ResourceId</b></td></tr><tr><td style=\"display: none\">*</td><td>NRLSearchDocumentEntries</td></tr></table><h3>Responses</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>ResourceId</b></td></tr><tr><td style=\"display: none\">*</td><td>NRLReturnDocumentEntries</td></tr></table></blockquote></blockquote></blockquote><blockquote><p><b>process</b></p><p><b>title</b>: Option - Retrieve selected imaging report</p><p><b>description</b>: </p><div><p>This is an optional step. The <strong>Document Consumer</strong> may choose to retrieve the <strong>Imaging Report</strong>. At present this is a <a href=\"https://www.rcr.ac.uk/media/wwtp2mif/rcr-publications_radiology-reporting-networks-understanding-the-technical-options_march-2022.pdf\">Royal College of Radiologists HL7 ORU</a> converted to a FHIR DiagnosticReport profile as <a href=\"StructureDefinition-ImagingReport.html\">Imaging Report</a>, this also contains mappings between HL7 ORU and FHIR DiagnosticReport.</p>\n<p>Other options are being discussed by HL7 Europe such as a <a href=\"https://health.ec.europa.eu/document/download/0079ad26-8f8f-435b-9472-3cd8625f4220_en?filename=ehn_mi_guidelines_en.pdf\">EU Medical imaging studies and reports</a> which is likely to be a derivative of <a href=\"https://build.fhir.org/ig/HL7/fhir-ips/index.html\">HL7 IPS</a>, like the <a href=\"https://build.fhir.org/ig/hl7-eu/laboratory/\">HL7 Europe Laboratory Report</a>.</p>\n</div><blockquote><p><b>step</b></p><blockquote><p><b>operation</b></p><p><b>number</b>: 1</p><p><b>type</b>: search-type</p><p><b>name</b>: Retrieve Imaging Report by searching on a _id </p><p><b>initiator</b>: user</p><p><b>receiver</b>: docs</p><h3>Requests</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>ResourceId</b></td></tr><tr><td style=\"display: none\">*</td><td>NRLSearchDiagnosticReports</td></tr></table><h3>Responses</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>ResourceId</b></td></tr><tr><td style=\"display: none\">*</td><td>NRLReturnDiagnosticReports</td></tr></table></blockquote></blockquote></blockquote><blockquote><p><b>process</b></p><p><b>title</b>: Option - Retrieve selected imaging study</p><p><b>description</b>: </p><div><p>This is an optional step. The <strong>Document Consumer</strong> may choose to retrieve the Imaging Study. At present this is a <a href=\"https://dicom.nema.org/dicom/supps/sup59_lb.pdf\">DICOM KOS</a> which contains DICOM modalities to used for retrieval of the Image Instances.</p>\n<p>Other options include using FHIR ImagingStudy which is a FHIR version of the DICOM KOS.</p>\n</div><blockquote><p><b>step</b></p><blockquote><p><b>operation</b></p><p><b>number</b>: 1</p><p><b>type</b>: read</p><p><b>name</b>: Retrieve Imaging Study</p><p><b>initiator</b>: user</p><p><b>receiver</b>: image</p><h3>Requests</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>ResourceId</b></td></tr><tr><td style=\"display: none\">*</td><td>NRLRetrieveImagingStudy</td></tr></table><h3>Responses</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>ResourceId</b></td></tr><tr><td style=\"display: none\">*</td><td>NRLRetrieveImagingStudyResult</td></tr></table></blockquote></blockquote><blockquote><p><b>step</b></p><blockquote><p><b>process</b></p><p><b>title</b>: Retrieve selected image (optional)</p><blockquote><p><b>step</b></p><blockquote><p><b>operation</b></p><p><b>number</b>: 1</p><p><b>type</b>: read</p><p><b>name</b>: Retrieve Image</p><p><b>initiator</b>: user</p><p><b>receiver</b>: image</p><h3>Requests</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>ResourceId</b></td></tr><tr><td style=\"display: none\">*</td><td>NRLRetrieveImage</td></tr></table><h3>Responses</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>ResourceId</b></td></tr><tr><td style=\"display: none\">*</td><td>NRLRetrieveImageResult</td></tr></table></blockquote></blockquote></blockquote></blockquote></blockquote></div>"
  },
  "url" : "https://fhir.nhs.uk/England/RAD/ExampleScenario/FindingImagingReportsStudiesAndImagesCentralRegistry",
  "version" : "0.0.1-current",
  "name" : "FindingImagingReportsStudiesAndImagesCentralRegistry",
  "status" : "draft",
  "date" : "2025-04-09T05:34:28+00:00",
  "publisher" : "NHS England",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://www.ihe.net/ihe_domains/it_infrastructure/"
        }
      ]
    },
    {
      "telecom" : [
        {
          "system" : "email",
          "value" : "iti@ihe.net"
        }
      ]
    },
    {
      "name" : "NHS England",
      "telecom" : [
        {
          "system" : "email",
          "value" : "iti@ihe.net"
        }
      ]
    }
  ],
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "GB",
          "display" : "United Kingdom of Great Britain and Northern Ireland"
        }
      ]
    }
  ],
  "actor" : [
    {
      "actorId" : "user",
      "type" : "entity",
      "name" : "Document Consumer",
      "description" : "The [Document Consumer](ActorDefinition-DocumentConsumer.html) Actor queries for documents meeting certain criteria, and may retrieve selected documents."
    },
    {
      "actorId" : "xds",
      "type" : "entity",
      "name" : "Document Registry",
      "description" : "The [Document Registry](ActorDefinition-DocumentRegistry.html) Actor maintains metadata about each registered document in a document entry. This includes a link to the Document in the Repository where it is stored. The Document Registry responds to queries from Document Consumer actors about documents meeting specific criteria."
    },
    {
      "actorId" : "docs",
      "type" : "entity",
      "name" : "Document Repository",
      "description" : "The [Document Repository](ActorDefinition-DocumentRepository.html) is responsible for both the persistent storage of these documents (e.g. Imaging Report)"
    },
    {
      "actorId" : "image",
      "type" : "entity",
      "name" : "Imaging Repository",
      "description" : "The [Imaging Repository](ActorDefinition-ImagingRepository.html) is responsible for both the persistent storage of DICOM Images and Imaging Studies, these may also contain Imaging Reports. This is also known as a PACS."
    }
  ],
  "instance" : [
    {
      "resourceId" : "NRLSearchDocumentEntries",
      "resourceType" : "Binary",
      "name" : "Query for Document Entries",
      "description" : " See [Finding and Retrieving Document Entries (NRL)](CapabilityStatement-FindDocumentsNRL.html) for API base contract. E.g. \n```\nGET https://example.nhs.uk/FHIR/R4/DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|9912003888\n```\n "
    },
    {
      "resourceId" : "NRLReturnDocumentEntries",
      "resourceType" : "Bundle",
      "name" : "Return Document Entry results",
      "version" : [
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.title",
              "valueString" : "Search Results NRL"
            },
            {
              "url" : "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.content",
              "valueReference" : {
                "reference" : "Bundle/NRLSearchResultsDocuments"
              }
            }
          ],
          "versionId" : "1"
        }
      ]
    },
    {
      "resourceId" : "NRLSearchDiagnosticReports",
      "resourceType" : "Binary",
      "name" : "Query for DiagnosticReport",
      "description" : " See [Find and Retrieve Imaging Reports](CapabilityStatement-FindAndRetrieveImagingReports.html) for API base contract. E.g. \n```\nGET https://example.nhs.uk/FHIR/R4/DiagnosticReport?_id=ABCD\n```\n "
    },
    {
      "resourceId" : "NRLReturnDiagnosticReports",
      "resourceType" : "Bundle",
      "name" : "Return DiagnosticReport results",
      "version" : [
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.title",
              "valueString" : "Search Diagnostic Report by _id "
            },
            {
              "url" : "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.content",
              "valueReference" : {
                "reference" : "Bundle/NRLSearchDiagnosticReports"
              }
            }
          ],
          "versionId" : "1"
        }
      ]
    },
    {
      "resourceId" : "NRLRetrieveImagingStudy",
      "resourceType" : "Binary",
      "name" : "Read ImagingStudy",
      "description" : "See [Retrieve Imaging Study](CapabilityStatement-RetrieveImagingStudy.html) for API overview "
    },
    {
      "resourceId" : "NRLRetrieveImagingStudyResult",
      "resourceType" : "Binary",
      "name" : "Return Imaging Study",
      "description" : " DICOM KOS "
    },
    {
      "resourceId" : "NRLRetrieveImage",
      "resourceType" : "Binary",
      "name" : "Read Image Instance",
      "description" : "See [Retrieve Image Instances](CapabilityStatement-RetrieveImageInstances.html) for API overview "
    },
    {
      "resourceId" : "NRLRetrieveImageResult",
      "resourceType" : "Binary",
      "name" : "Return Image",
      "description" : " DICOM Image Instance "
    }
  ],
  "process" : [
    {
      "title" : "Query patient image and/or report",
      "step" : [
        {
          "operation" : {
            "number" : "1",
            "type" : "search-type",
            "name" : "Search for Documents",
            "initiator" : "user",
            "receiver" : "xds",
            "request" : {
              "resourceId" : "NRLSearchDocumentEntries"
            },
            "response" : {
              "resourceId" : "NRLReturnDocumentEntries"
            }
          }
        }
      ]
    },
    {
      "title" : "Option - Retrieve selected imaging report",
      "description" : "This is an optional step. The **Document Consumer** may choose to retrieve the **Imaging Report**. At present this is a [Royal College of Radiologists HL7 ORU](https://www.rcr.ac.uk/media/wwtp2mif/rcr-publications_radiology-reporting-networks-understanding-the-technical-options_march-2022.pdf) converted to a FHIR DiagnosticReport profile as [Imaging Report](StructureDefinition-ImagingReport.html), this also contains mappings between HL7 ORU and FHIR DiagnosticReport. \n\n Other options are being discussed by HL7 Europe such as a [EU Medical imaging studies and reports](https://health.ec.europa.eu/document/download/0079ad26-8f8f-435b-9472-3cd8625f4220_en?filename=ehn_mi_guidelines_en.pdf) which is likely to be a derivative of [HL7 IPS](https://build.fhir.org/ig/HL7/fhir-ips/index.html), like the [HL7 Europe Laboratory Report](https://build.fhir.org/ig/hl7-eu/laboratory/).",
      "step" : [
        {
          "operation" : {
            "number" : "1",
            "type" : "search-type",
            "name" : "Retrieve Imaging Report by searching on a _id ",
            "initiator" : "user",
            "receiver" : "docs",
            "request" : {
              "resourceId" : "NRLSearchDiagnosticReports"
            },
            "response" : {
              "resourceId" : "NRLReturnDiagnosticReports"
            }
          }
        }
      ]
    },
    {
      "title" : "Option - Retrieve selected imaging study",
      "description" : "This is an optional step. The **Document Consumer** may choose to retrieve the Imaging Study. At present this is a [DICOM KOS](https://dicom.nema.org/dicom/supps/sup59_lb.pdf) which contains DICOM modalities to used for retrieval of the Image Instances. \n\nOther options include using FHIR ImagingStudy which is a FHIR version of the DICOM KOS.",
      "step" : [
        {
          "operation" : {
            "number" : "1",
            "type" : "read",
            "name" : "Retrieve Imaging Study",
            "initiator" : "user",
            "receiver" : "image",
            "request" : {
              "resourceId" : "NRLRetrieveImagingStudy"
            },
            "response" : {
              "resourceId" : "NRLRetrieveImagingStudyResult"
            }
          }
        },
        {
          "process" : [
            {
              "title" : "Retrieve selected image (optional)",
              "step" : [
                {
                  "operation" : {
                    "number" : "1",
                    "type" : "read",
                    "name" : "Retrieve Image",
                    "initiator" : "user",
                    "receiver" : "image",
                    "request" : {
                      "resourceId" : "NRLRetrieveImage"
                    },
                    "response" : {
                      "resourceId" : "NRLRetrieveImageResult"
                    }
                  }
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.